Broadband - Appointment Management API - TMF646

API Request Payload

HTTP Header Name	Example Field Value	Description
Correlation-ID	c97ded75-44fa-4b69-9f3b-01d513a41efe	A GUID to relate requests belonging to the same transaction

Payload Field Name	Example Field Value	Description
appointmentType	Standard Flexible	Extension to the API. It defines the Type of Appointment the Partner is requesting from those offered by the suppliers.
category	Repair	Extension to the API. It defines the Type of the Appointment whether for Repair, Order provisioning or Order Modification.
requestedTimeslot	See requestedTimeslot table	array
relatedParty	See relatedParty table	array
relatedEntity	See relatedEntity table	array for AccessCASR contains a AccessCASR and the BillingAccount elements id = {{AccessCASR}} role = relatedService @referredType = Service for ProductId contains a ProductId and the BillingAccount elements id = {{ProductId}} role = relatedProduct @referredType = Product for CLI contains the CLI and the BillingAccountId elements id = {{CLI}} role = impactedVoiceService @referredType = Service
@type	PXCSearchTimeSlot
@baseType	SearchTimeSlot

Requested Timeslot Table

Field Name	Example Field Value	Description
validFor		Mandatory - Object
startDateTime	2025-02-15T00:00:00.000Z	Mandatory - Timestamp of the start time to get available appointments from.
endDateTime	2025-02-15T00:00:00.000Z	Optional - Timestamp of the end time the appointment is requested for. This is not required, but if populated it will be ignored.

Related Party Table

Field Name	Example Field Value	Description
id	2111	Mandatory - Partners Unique Id.
role	relatedAgent	Mandatory - Role played by the client.
@referredType	Party	The actual type of the target instance.

Related Entity Table

Field Name	Example Field Value	Description
id	AP12345678 FTTP12345678 SOGEA12345678 01234567891 INC123456789101 00000069 AO12345678	Mandatory - Unique Id - eg: ProductId, AccessCASR, CLI, TicketId, BillingAccountId or OrderId
role	relatedProduct relatedService relatedTicket relatedAccount relatedOrder impactedVoiceService impactedDataService	Mandatory - Role played by the client. relatedProduct when Id is ProductId relatedService when Id is AccessCASR relatedTicket when Id is TicketId relatedAccount when Id is BillingAccountId relatedOrder when Id is OrderId impactedVoiceService when Id is CLI impactedDataService when Id is CLI
@referredType	Product Service Ticket BillingAccount Order	Mandatory - The actual type of the target instance Product when Id is ProductId Service when ID is AccessCASR & CLI Ticket when Id is TicketId BillingAccount when Id is BillingAccountId Order when Id is OrderId.

Note that relatedEntity of @referredType=Ticket is expected in requests when an appointment is being reserved for an existing ticket

API Response Payload

HTTP Header Name	Example Field Value	Description
Correlation-ID	c97ded75-44fa-4b69-9f3b-01d513a41efe	A GUID to relate requests belonging to the same transaction

Payload Field Name	Example Field Value	Description
searchDate	2025-02-01T14:48:45.071Z	Timestamp of when the searchTimeslot request was performed.
searchResult	success	Result of the searchTimeslot. Will be set to success.
category	Repair	Extension to the API. It defines the Type of the Appointment whether for Repair, Order provisioning or Order Modification.
appointmentType	Standard Flexible	Extension to the API. It defines the Type of Appointment the Partner is requesting from those offered by the suppliers.
requestedTimeslot	See requestedTimeslot table	array
relatedEntity	See relatedEntity table	for AccessCASR contains a AccessCASR and the BillingAccount elements id = {{AccessCASR}} role = relatedService @referredType = Service for ProductId contains a ProductId and the BillingAccount elements id = {{ProductId}} role = relatedProduct @referredType = Product for CLI contains the CLI and the BillingAccountId elements id = {{CLI}} role = impactedVoiceService @referredType = Service
availableTimeslot	See availableTimeslot table	array
status	done	Status of the searchTimeslot. Will be set to done.
@type	PXCSearchTimeSlot
@baseType	SearchTimeSlot

Requested Timeslot Table

Field Name	Example Field Value	Description
validFor		Mandatory - Object
startDateTime	2025-02-15T00:00:00.000Z	Mandatory - Timestamp of the start time to get available appointments from.
endDateTime	2025-02-15T00:00:00.000Z	Optional - Timestamp of the end time the appointment is requested for. This is not required, but if populated it will be ignored.

Related Entity Table

Field Name	Example Field Value	Description
id	AP12345678 FTTP12345678 SOGEA12345678 01234567891 INC123456789101 00000069 AO12345678	Mandatory - Unique Id - eg: ProductId, AccessCASR, CLI, TicketId, BillingAccountId or OrderId
role	relatedProduct relatedService relatedTicket relatedAccount relatedOrder impactedVoiceService impactedDataService	Mandatory - Role played by the client. relatedProduct when Id is ProductId relatedService when Id is AccessCASR relatedTicket when Id is TicketId relatedAccount when Id is BillingAccountId relatedOrder when Id is OrderId impactedVoiceService when Id is CLI impactedDataService when Id is CLI
@referredType	Product Service Ticket BillingAccount Order	Mandatory - The actual type of the target instance Product when Id is ProductId Service when ID is AccessCASR & CLI Ticket when Id is TicketId BillingAccount when Id is BillingAccountId Order when Id is OrderId.

Available Timeslot Table

Field Name	Example Field Value	Description
validFor		Mandatory - Object
startDateTime	2025-02-15T08:00:00.000Z	Mandatory - Timestamp of the start time of the time period for the appointment to start.
endDateTime	2025-02-15T13:00:00.000Z	Optional - Timestamp of the end time the appointment is requested for. This is not required, but if populated it will be ignored.